:::
 

EbrMessageFormat

All EbrMessages use the MimeFormat. The MimeFormat outlines well-established guidelines on how to package mixed data payloads (plain text, images, binary data, etc.) for network transmission.

An EbrMessage may consist of one or more EbrMessageParts, with each EbrMessagePart possibly being of different content type. EbrMessages legally extend the MimeFormat by adding application specific EbrMessageHeaders that provide meta-information about the message, enabling EbrNodes to rapidly route the EbrMessages to their correct destination without inspecting the payload content.

A single-part EbrMessage can be visualised as:

SinglePartMime.jpg

Example Message

Example single-part EbrMessage with full MimeHeaders.

Message-ID: <15813867.1016795026046.JavaMail.mwood@eh1>
Mime-Version: 1.0
Content-Type: multipart/mixed; boundary="----=_Part_0_5737707.1016795025947"
X-Ebr-Message-ID: MY_UNIQUE_ID
X-Ebr-Part-Count: 1
X-Ebr-Total-Cost-Euro: 200
X-Ebr-Version: 2.00
X-Ebr-Time-Stamp: 2002-07-23 16:38:15
X-Ebr-Routing: standard
X-Ebr-Mode: 3

------=_Part_0_5737707.1016795025947
Content-Type: application/octet-stream; name=CompanyReportRequest.xml
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename=CompanyReportRequest.xml
X-Ebr-Source: dev_ndc
X-Ebr-Destination: dev_ngc
X-Ebr-User-ID: orc/1234
X-Ebr-Local-ID: orc/111ABC
X-Ebr-Service: CompanyReport
X-Ebr-Service-Status: 0
X-Ebr-Core-Status: 0
X-Ebr-Part-ID: MY_UNIQUE_ID/0
X-Ebr-Part-Number: 0
X-Ebr-Part-Cost-Euro: 20
X-Ebr-Session-ID: 20
X-Ebr-Log-Key: 0
X-Ebr-Delivery-Method: inline
X-Ebr-Delivery-Info:

<?xml version="1.0" encoding="UTF-8"?>
<!--Sample XML file generated by XML Spy v4.2 U (http://www.xmlspy.com)-->
<CompanyReportRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="Z:\EBR\Orchid\Schemas\Message Based\CompanyReportRequest.xsd">
<companyCode>00002065</companyCode>
<chamberOfCommerce>Wales</chamberOfCommerce>
</CompanyReportRequest>

------=_Part_0_5737707.1016795025947--

(Always refer to the EbrMessageHeaderTable for the latest set of EbrMessageHeaders. Examples may reference older EbrProtocol versions)

The "------=_Part_0_5737707.1016795025947" lines designate the boundary between parts. This message consists of a single part that carries an XML payload request for the "CompanyReport" service.

Multipart Message

An EbrMessage may contain more than one EbrMessagePart, e.g.

MultiPartMime.jpg

Example Multi Part Ebr Message Request

The following listing shows a MultiPartEbrMessage consisting of two requests, a CompanySearch request to Sweden (PRV) for the company “IBM” and a similar request to Belgium (Euro DB) for “Microsoft”.

Message-ID: <776128.1050068433655.JavaMail.ebradmin@eh2>
Mime-Version: 1.0
Content-Type: multipart/mixed; 
boundary="----=_Part_936_11128290.1050068433654"
X-Ebr-Message-ID: 2003-04-11 14:40:33.0.6470314347600303
X-Ebr-Time-Stamp: 2003-04-11 14:40:33
X-Ebr-Part-Count: 2
X-Ebr-Version: 2.00
X-Ebr-Mode: 3
X-Ebr-Routing: standard
X-Ebr-Total-Cost-Euro: 

------=_Part_936_11128290.1050068433654
Content-Type: text/xml; charset="utf-8"
Content-Transfer-Encoding: 7bit
X-Ebr-Service: EBR_CompanySearch_1
X-Ebr-Source: GBR_ND_orchid
X-Ebr-Destination: SWE_NG_PRV
X-Ebr-User-ID: 
X-Ebr-Local-ID: GBR_LD_Orchid
X-Ebr-Service-Status: 0
X-Ebr-Core-Status: 0
X-Ebr-Part-ID: 2003-04-11 14:40:33.0.6470314347600303/1
X-Ebr-Part-Number: 1
X-Ebr-Part-Cost-Euro: 0
X-Ebr-Session-ID: 
X-Ebr-Log-Key: ibm
X-Ebr-Delivery-Method: 
X-Ebr-Delivery-Info: 

<?xml version="1.0" encoding="UTF-8"?>
<CompanySearchRequest xmlns="http://ebr.orctel.com/ebr/xml/CompanySearchRequest">
<EBRHeader />
<GeneralInfo>
<CompanyName>ibm</CompanyName>
</GeneralInfo>
</CompanySearchRequest>

------=_Part_936_11128290.1050068433654
Content-Type: text/xml; charset="utf-8"
Content-Transfer-Encoding: 7bit
X-Ebr-Service: EBR_CompanySearch_1
X-Ebr-Source: GBR_ND_orchid
X-Ebr-Destination: BEL_NG_edbfr
X-Ebr-User-ID: 
X-Ebr-Local-ID: GBR_LD_Orchid
X-Ebr-Service-Status: 0
X-Ebr-Core-Status: 0
X-Ebr-Part-ID: 2003-04-11 14:40:33.0.6470314347600303/2
X-Ebr-Part-Number: 2
X-Ebr-Part-Cost-Euro: 0
X-Ebr-Session-ID: 
X-Ebr-Log-Key: microsoft
X-Ebr-Delivery-Method: 
X-Ebr-Delivery-Info: 

<?xml version="1.0" encoding="UTF-8"?>
<CompanySearchRequest xmlns="http://ebr.orctel.com/ebr/xml/CompanySearchRequest">
<EBRHeader />
<GeneralInfo>
<CompanyName>microsoft</CompanyName>
</GeneralInfo>
</CompanySearchRequest>

------=_Part_936_11128290.1050068433654--

(Always refer to the EbrMessageHeaderTable for the latest set of EbrMessageHeaders. Examples may reference older EbrProtocol versions)

See also: ExampleMultiPartEbrMessageReply

Example Multi Part Ebr Message Reply

The following listing gives the result of the previous ExampleMultiPartEbrMessageRequest, it is a MultiPartEbrMessage reply that contains the CompanySearch results from the two countries (the list results are snipped at one entry for brevity).

Message-ID: <8897128.1052389532717.JavaMail.orcldc@eh2>
Mime-Version: 1.0
Content-Type: multipart/mixed; 
boundary="----=_Part_22_8442367.1052389532696"
X-Ebr-Message-ID: 2003-04-11 14:40:33.0.6470314347600303
X-Ebr-Time-Stamp: 2003-04-11 14:40:33
X-Ebr-Part-Count: 2
X-Ebr-Version: 2.00
X-Ebr-Mode: 3
X-Ebr-Routing: standard
X-Ebr-Total-Cost-Euro: 

------=_Part_22_8442367.1052389532696
Content-Type: text/xml; charset="utf-8"
Content-Transfer-Encoding: 7bit
X-Ebr-Service: EBR_CompanySearch_1
X-Ebr-Source: GBR_ND_orchid
X-Ebr-Destination: SWE_NG_PRV
X-Ebr-User-ID: 
X-Ebr-Local-ID: GBR_LD_Orchid
X-Ebr-Service-Status: 0
X-Ebr-Core-Status: 0
X-Ebr-Part-ID: 2003-04-11 14:40:33.0.6470314347600303/0
X-Ebr-Part-Number: 0
X-Ebr-Part-Cost-Euro: 1.23
X-Ebr-Session-ID: 
X-Ebr-Log-Key: ibm
X-Ebr-Delivery-Method: 
X-Ebr-Delivery-Info: 

<?xml version="1.0" encoding="UTF-8"?>
<CompanySearchReply xmlns="http://ebr.orctel.com/ebr/xml/CompanySearchReply">
<EBRHeader>
<DataInfo ItemsMatched="9" ItemsReturned="9" />
</EBRHeader>
<CompanyList>
<CompanyEntry>
<GeneralInfo>
<ID type="company">
<Code>5560266883</Code>
<CountryTD Owner="EBR" Version="1" ID="default" Table="Country" Code="SWE" />
<RegistrationAuthorityTD Owner="SWE_NG_PRV" Version="1" ID="default" Table="RegistrationAuthority" Code="PRV" />
</ID>
<CompanyName>IBM Svenska Aktiebolag</CompanyName>
</GeneralInfo>
<RegistrationInfo>
<RegistrationAuthorityTD Owner="SWE_NG_PRV" Version="1" ID="default" Table="RegistrationAuthority" Code="PRV" />
</RegistrationInfo>
<StatutoryInfo>
<LegalFormTD Owner="SWE_NG_PRV" Version="1" ID="default" Table="LegalForm" Code="AB" />
<StatusGroupTD Owner="EBR" Version="1" ID="default" Table="StatusGroup" Code="AC" />
</StatutoryInfo>
<ContactInfo>
<Address>
<AddressTypeTD Owner="EBR" Version="1" ID="default" Table="AddressType" Code="LOC" />
<AddressLine Order="1" Value="STOCKHOLM">
<AddressLineTD Owner="EBR" Version="1" ID="default" Table="AddressLine" Code="TWN" />
</AddressLine>
</Address>
</ContactInfo>
</CompanyEntry>
</CompanyList>
</CompanySearchReply>

------=_Part_22_8442367.1052389532696
Content-Type: text/xml; charset="utf-8"
Content-Transfer-Encoding: 7bit
X-Ebr-Service: EBR_CompanySearch_1
X-Ebr-Source: GBR_ND_orchid
X-Ebr-Destination: BEL_NG_edbfr
X-Ebr-User-ID: 
X-Ebr-Local-ID: GBR_LD_Orchid
X-Ebr-Service-Status: 0
X-Ebr-Core-Status: 0
X-Ebr-Part-ID: 2003-04-11 14:40:33.0.6470314347600303/0
X-Ebr-Part-Number: 0
X-Ebr-Part-Cost-Euro: 0
X-Ebr-Session-ID: 
X-Ebr-Log-Key: Company Search reply for name=microsoft&
X-Ebr-Delivery-Method: Inline
X-Ebr-Delivery-Info: 

<?xml version="1.0" encoding="UTF-8"?>
<CompanySearchReply xmlns="http://ebr.orctel.com/ebr/xml/CompanySearchReply" Source="Euro DB" Official="true">
<EBRHeader>
<DataInfo ItemsReturned="6"/>
</EBRHeader>
<CompanyList>
<CompanyEntry>
<GeneralInfo>
<ID type="company">
<Code>429391680</Code>
</ID>
<CompanyName>ALINEA PARTNERS</CompanyName>
</GeneralInfo>
<StatutoryInfo>
<StatusGroupTD Owner="EBR" Version="1" ID="default" Table="StatusGroup" Code="LG"/>
</StatutoryInfo>
<ContactInfo>
<Address>
<AddressTypeTD Owner="EBR" Version="1" ID="default" Table="AddressType" Code="LOC"/>
<AddressLine Order="3" Value="Avenue Wellington">
<AddressLineTD Owner="EBR" Version="1" ID="default" Table="AddressLine" Code="STR"/>
</AddressLine>
<AddressLine Order="4" Value="136">
<AddressLineTD Owner="EBR" Version="1" ID="default" Table="AddressLine" Code="NBR"/>
</AddressLine>
<AddressLine Order="5" Value="1180">
<AddressLineTD Owner="EBR" Version="1" ID="default" Table="AddressLine" Code="CPT"/>
</AddressLine>
<AddressLine Order="6" Value="BRUXELLES">
<AddressLineTD Owner="EBR" Version="1" ID="default" Table="AddressLine" Code="TWN"/>
</AddressLine>
</Address>
</ContactInfo>
</CompanyEntry>
</CompanyList>
</CompanySearchReply>

------=_Part_22_8442367.1052389532696--

(Always refer to the EbrMessageHeaderTable for the latest set of EbrMessageHeaders. Examples may reference older EbrProtocol versions)

See also: MimeFormat, EbrMessageFormat, EbrMessageGlobalHeader, EbrMessagePartHeaders



   


Topic revision r1.7 - 24 Oct 2003 - 12:50 GMT - MartinWood
Topic parents: WebHome
Copyright © 1999-2003 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback.